GtkOverlay: Update the description
authorMatthias Clasen <mclasen@redhat.com>
Fri, 21 Aug 2015 22:19:26 +0000 (18:19 -0400)
committerMatthias Clasen <mclasen@redhat.com>
Fri, 21 Aug 2015 22:19:26 +0000 (18:19 -0400)
State that the overlays are placed wrt to the GtkOverlay, not
with respect to the main widget. This makes a difference for
small main widgets which are not configured to fill the entire
GtkOverlay.

gtk/gtkoverlay.c

index cbad6b89437360a6c1abb704945d2bfe46ff869e..7a7d6e1df5a9aa2d08ad2733e8445508ae4c3983 100644 (file)
  * @title: GtkOverlay
  *
  * GtkOverlay is a container which contains a single main child, on top
- * of which it can place “overlay” widgets. The
- * position of each overlay widget is determined by its #GtkWidget:halign
- * and #GtkWidget:valign properties. E.g. a widget with both alignments
- * set to %GTK_ALIGN_START will be placed at the top left corner of the
- * main widget, whereas an overlay with halign set to %GTK_ALIGN_CENTER
- * and valign set to %GTK_ALIGN_END will be placed a the bottom edge of
- * the main widget, horizontally centered. The position can be adjusted
- * by setting the margin properties of the child to non-zero values.
+ * of which it can place “overlay” widgets. The position of each overlay
+ * widget is determined by its #GtkWidget:halign and #GtkWidget:valign
+ * properties. E.g. a widget with both alignments set to %GTK_ALIGN_START
+ * will be placed at the top left corner of the GtkOverlay container,
+ * whereas an overlay with halign set to %GTK_ALIGN_CENTER and valign set
+ * to %GTK_ALIGN_END will be placed a the bottom edge of the GtkOverlay,
+ * horizontally centered. The position can be adjusted by setting the margin
+ * properties of the child to non-zero values.
  *
  * More complicated placement of overlays is possible by connecting
  * to the #GtkOverlay::get-child-position signal.